.. _cmmSxWaitDone:

cmmSxWaitDone
==============
--------------

SYNOPSYS
`````````````

.. code-block:: none

    VT_I4 cmmSxWaitDone(
        [in] VT_I4 Axis, [in] VT_I4 IsBlocking
        )


DESCRIPTION
`````````````

- 단일 축에 대하여 모션이 완료 될 때까지 기다립니다.

PARAMETER
`````````````

- Axis: 축번호. 축번호는 상수값으로 [cmX1] 부터 0 번째 축을 기준 축으로 임의의 축을 설정할 수 있습니다.

\

- IsBlocking : 완료될 때까지 기다리는 동안 윈도우 메시지를 블록할 것인지를 결정합니다.


.. csv-table::
    :widths: 10 85
    :header-rows: 1
    :stub-columns: 0 

    Value, Meaning
    cmFALSE, 블록(Blocking)을 하지 않습니다. 따라서 해당 모션이 완료되는 동안에도 윈도우 이벤트를 처리합니다.
    cmTrue, 블록(Blocking)을 합니다. 따라서 모션이 완료되는 동안에는 윈도우 이벤트가 처리되지 않습니다.


RETURN VALUE
`````````````

+--------------+--------------------------------+
| Value        | Meaning                        |
+==============+================================+
| 음수         | 수행 실패 또는 모션에러 발생   |
+--------------+--------------------------------+
| cmERR_NONE   | 수행 성공                      |
+--------------+--------------------------------+


REFERENCE
````````````

- INP 입력신호가 Enable 로 설정되었으면 Command 펄스 출력이 완료되어도 INP 입력이 ON 이 되기 전까지는
  모션이 완료되지 않은 것으로 간주되어 반환되지 않습니다. 

\

- 스탭 드라이브를 사용 중인 고객님들께서는 다음을 참조해 주십시요.
  스탭 드라이브는 INP 출력이 없는 경우가 일반적인데, 고객님의 부주의나 잘못된 설정으로 INP 입력에 대한
  설정이 Enable 로 되어 있을 경우 INP 입력이 스탭 드라이브를 통해 발생하지 않는 이유 때문에 모션 완료가 되지
  않는 경우가 발생할 수 있습니다. 고객 여러분들께서는 스탭 드라이브 사용시에 이점을 주의해주시기를
  부탁드립니다.

\

- 서보 드라이브의 LSP , LSN 신호를 사용 중인 고객님께서는 다음을 참조해 주십시요.
  서보드라이브의 입력 신호 중 하나인 EL(End of Limit) 신호는 저희 ㈜ 커미조아 모션 보드 뿐만 아니라
  서보드라이브에도 전달 될 수 있도록 설정할 수 있습니다. 통상적으로 LSP 신호와 LSN 신호로 불리어 지는 이
  신호는 실제 기구물에서 양의 방향(Positive Direction) 혹은 음의 방향(Negative Direction) 에 장착되어 있는 EL(End of 
  Limit) 신호를 서보 드라이브 측에 전달하기 위한 용도로 사용됩니다.

  그러나, 모션 소프트웨어에서 INP 설정이 되어 있는 경우 EL 신호가 검출 된 후에 일부 서보 드라이브에서는 진행
  방향에서 정지(停止) 한후 더 이상 움직이지 않는 상황이 발생하며, 이 상황에서 INP 신호가 출력되지 않아, 모션
  이송이 완료되지 못하고, 명시적으로 STOP 을 해줘야만 하는 강제적으로 모션 종료가 되는 현상이 발생할 수 
  있습니다. 이 현상은 EL 모드를 통해 원점 복귀를 하는 상황에서도 발생할 수 있습니다.

  따라서, 이러한 경우에는 반드시 원점 복귀나 EL 검출시에 인터럽트 이벤트나 타이머를 통해 INP 를 무기한
  대기하는 현상에 대해서 적절히 대처하시거나 INP 신호 사용을 배제 해야 합니다.


EXAMPLE
`````````

.. code-block:: c++ 
 :linenos:
 :emphasize-lines: 5

 C/C++ 

 if(cmmSxMoveStart(cmX1, 5000.0) != cmERR_NONE){
    cmmErrShowLast(Handle);
    return ;
 }

 //모션이 완료 될 때 까지 기다립니다.
 if(cmmSxWaitDone(cmX1, cmFALSE) != cmERR_NONE){
    cmmErrShowLast(Handle);
    return ;
 }


.. code-block:: none
 :linenos:

 Visual Basic

 If(cmmSxMoveStart(cmX1, 1000) <> cmERR_NONE) Then
    Call cmmErrShowLast(Handle) ‘// 핸들은 사용자 윈도우의 핸들입니다.
    Exit Sub
 End If

 ‘Wait till motion done
 If(cmmSxWaitDone(cmX1, cmFALSE) <> cmERR_NONE) Then
    Call cmmErrShowLast(Handle)
    Exit Sub
 End If


.. code-block:: none
 :linenos:

 Delphi

 if(cmmSxMoveStart(cmX1, 1000) <> cmERR_NONE) then begin
    cmmErrShowLast(Handle);
    exit
 end;

 //Wait till motion done //
 if(cmmSxWaitDone(cmX1, cmFALSE) <> cmERR_NONE) then begin
    cmmErrShowLast(Handle);
    exit;
 end;